home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / basic / fossc004.zip / FOSSCOMM.DOC < prev    next >
Text File  |  1988-10-31  |  28KB  |  833 lines
  1.           .FQ
  2. l-@10i--TL----+-T--2----T----3--T-+----4T---+---T5----+-T--6----T----C--T-+----r
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.          
  14.          
  15.          
  16.          
  17.                                     FossComm
  18.          
  19.                                   version 0.04
  20.          
  21.  
  22.                                   August 22, 1988
  23.  
  24.          
  25.                              Program Documentation
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                      Copyright (C) 1988  Daan van der Weide
  32.                               All rights reserved
  33.  
  34. l-@10i--TL----+-T--2----T----3--T-+----4T---+---T5----+-T--6----T----J--T-+----r
  35.           .N:2
  36.           .F:------------------------------------------------------------
  37.           .F:FossComm...page $$$...FossComm
  38.           .F:
  39.           
  40.  
  41.            FosComm  is  an interface between a compiled BASIC  program 
  42.          and a so-called FOSSIL  driver.  It enables the  user to take 
  43.          advantage  of  all the functions regarding the  communication 
  44.          ports,  from  a BASIC program.  In this way it is possible to 
  45.          avoid  the problems/shortcomings of the  BASIC communications 
  46.          handler. 
  47.  
  48.            FossComm  is based on the document 'Fundamentals of  FOSSIL 
  49.          implementation and use,  draft version 5, February 11,  1988' 
  50.          by Rick Moor.  Please make sure that your fossil driver meets 
  51.          this draft. 
  52.          
  53.          
  54.            FossComm can be used with any of the following compilers :
  55.  
  56.                 MicroSoft Quickbasic 1.00, 2.00, 3.00 and 4.00, 6.00
  57.                 IBM BasCom           1.00, 2.00
  58.  
  59.          
  60.          LICENSE AND REGISTRATION
  61.          ------------------------
  62.  
  63.            FossComm is distributed as a 'shareware'  program.   Please 
  64.          help  me get it known by giving away unmodified copies of the 
  65.          program and documentation to other people,  either by copying 
  66.          the  disk  or  making it available for downloading on  a  BBS 
  67.          system. 
  68.  
  69.            FossComm is copyright (C) 1988 by Daan van der Weide. It is 
  70.          not public domain or free software.  Non-registered users are 
  71.          granted  a limited license to use FossComm on a  trial  basis 
  72.          for  determining  whether  or not it is  suitable  for  their 
  73.          needs.   Registration allows the use of FossComm in  programs 
  74.          for sale and/or distribution. 
  75.          
  76.            The registration fee is 50 guilders (25 US$). Users who pay 
  77.          the  registration  fee  will be sent a disk woth  the  latest 
  78.          version and documentation ans some example programs. 
  79.  
  80.            It  is  also  possible  to  obtain  the  source  codes  for 
  81.          FossComm.  In that case the registration fee is 100  guilders 
  82.          (50 US$). 
  83.          
  84.            Register your usage of FossComm by sending the registration 
  85.          fee to :
  86.  
  87.                         Daan van der Weide
  88.                         Kastelenstraat 229-3
  89.                         1082 EG  Amsterdam
  90.                         the Netherlands
  91.  
  92.                         telephone : (0)20 463647
  93.  
  94.            Your   comments  regarding  the  FossComm  program  or  any 
  95.          suggestions  you  have for extensions or for  other  programs 
  96.          that would be useful to you are welcome. 
  97.  
  98.            Daan van der Weide makes no warranties whatsoever regarding 
  99.          the FossComm computer program or the documentation. 
  100.          
  101.  
  102.          USING FOSSCOMM IN YOUR PROGRAMS
  103.          -------------------------------
  104.  
  105.            The  FossComm  module contains a number of  functions  that 
  106.          handle the access of RS232  communication boards as  provided 
  107.          by a driver conform the FOSSIL standard. 
  108.  
  109.            Below follows a list of the functions supported and the 
  110.          parameters that should be specified, as well as the eventual 
  111.          return values. To incorporate the module within your compiled 
  112.          program specify the name FOSSCOMM.OBJ when linking your 
  113.          program. Example : 
  114.          
  115.            LINK MYPROG+FOSSCOMM,MYPROG;
  116.  
  117.          
  118.          CREDITS
  119.          -------
  120.  
  121.            I would like to mention a few people who have supported and 
  122.          still are supporting the development :
  123.  
  124.            Ronald Koridon who adapted RBBS 16.1a to run using FossComm 
  125.          and who is my primary 'guinea-pig'; Arjen Lentz, John Janssen 
  126.          sysops  that are using the RBBS 16.1a FOSSIL version as well. 
  127.          the RBBS version as well to run. (they've probably upgraded 
  128.          by now ...)
  129.  
  130.  
  131.          FEEDBACK
  132.          --------
  133.  
  134.            As you may know, any software developer depends on his 
  135.          users to modify, adjust and extend his product. Therefore 
  136.          I'm very interested in all comments, notes and critics 
  137.          towards the FossComm product. I can be reached either by 
  138.          telephone or, better, at the RBBS system listed below. Thank 
  139.          you very much !
  140.  
  141.                               RBBS Gaasperdam (4 lines)
  142.                               sysop Ronald Koridon
  143.                               Amsterdam, the Netherlands
  144.  
  145.                               31  (0)20 978493  node 1
  146.                                         913890  node 2
  147.                                         974420  node 3
  148.                                         972763  node 4
  149.  
  150.           
  151.          Revision history
  152.          ----------------
  153.  
  154.          v0.01
  155.  
  156.                 This is the first alpha-test version only released to
  157.          people involved in testing.
  158.  
  159.          
  160.          v0.02
  161.  
  162.                 Extended FOSSIL calls implemented to access keyboard 
  163.          and to do video I/O etc. Not released.
  164.  
  165.          
  166.          v0.03
  167.  
  168.                 Adaptions  according  to draft 5 are  made.   FOSSPEED 
  169.          changed, so that parity,  databits and the number of stopbits 
  170.          may be specified as well.  The documentation is extended, and 
  171.          a number of functions was added. 
  172.  
  173.          v0.04
  174.          
  175.                 I  think  the  product is solid enough to  release  it 
  176.          generally, especially because there's 'official' RBBS support 
  177.          for FossComm.  A  number of BBS systems are running for a few 
  178.          months now without any problems. 
  179.          
  180.           
  181.          -------------------------------------------------------------
  182.          FOSINIT
  183.          -------------------------------------------------------------
  184.          
  185.          PURPOSE :
  186.          
  187.            Initializes  the  FOSSIL  driver,  and checks  whether  the 
  188.          FOSSIL driver  is installed.  This function should be  called 
  189.          before any other FOS calls are made. DTR is raised by this 
  190.          call. The baudrate is NOT set by this call.
  191.          
  192.          
  193.          FORMAT  :
  194.          
  195.            FOSINIT(port%, result%)
  196.  
  197.          
  198.          RETURNS :
  199.          
  200.            0    no error, driver initialized
  201.           -1    error initializing driver
  202.  
  203.          
  204.          EXAMPLE :
  205.  
  206.            100 PORT% = 1
  207.            110 CALL FOSINIT(PORT%,RESULT%)
  208.            120 IF RESULT% = -1 THEN PRINT "ERROR INITIALIZING FOSSIL"
  209.          
  210.          
  211.          REMARKS :
  212.          
  213.            The  number of the comport that may be initialized  depends 
  214.          on  the particular FOSSIL driver you're using.  Refer to  the 
  215.          documentations of your driver for the values. 
  216.  
  217.            Should  a second call to this function occur,  all buffers, 
  218.          flow-contol parameters etc.  are reset to their initial state 
  219.          and no error is returned. 
  220.          
  221.          
  222.          -------------------------------------------------------------
  223.          FOSEXIT
  224.          -------------------------------------------------------------
  225.          
  226.          PURPOSE :
  227.  
  228.            This  function should be called whenever the communications 
  229.          port  in  no longer needed.  No FOS calls to  the  particular 
  230.          comport can be made anymore once this call has been made. DTR 
  231.          is not